Meshtastic App/com.geeksville.mesh/[androidJvm]ModuleConfigProtos/ModuleConfig/ExternalNotificationConfig/Builder

Builder

class Builder : GeneratedMessage.Builder<BuilderT> , ModuleConfigProtos.ModuleConfig.ExternalNotificationConfigOrBuilder


External Notifications Config

Protobuf type meshtastic.ModuleConfig.ExternalNotificationConfig

Functions

build

open fun build(): ModuleConfigProtos.ModuleConfig.ExternalNotificationConfig

buildPartial

open fun buildPartial(): ModuleConfigProtos.ModuleConfig.ExternalNotificationConfig

clear

open fun clear(): ModuleConfigProtos.ModuleConfig.ExternalNotificationConfig.Builder

clearActive

open fun clearActive(): ModuleConfigProtos.ModuleConfig.ExternalNotificationConfig.Builder


IF this is true, the 'output' Pin will be pulled active high, false
means active low.

bool active = 4;

clearAlertBell

open fun clearAlertBell(): ModuleConfigProtos.ModuleConfig.ExternalNotificationConfig.Builder


True: Alert when the bell character is received (output)

bool alert_bell = 6;

clearAlertBellBuzzer

open fun clearAlertBellBuzzer(): ModuleConfigProtos.ModuleConfig.ExternalNotificationConfig.Builder


True: Alert when the bell character is received (output_buzzer)

bool alert_bell_buzzer = 13;

clearAlertBellVibra

open fun clearAlertBellVibra(): ModuleConfigProtos.ModuleConfig.ExternalNotificationConfig.Builder


True: Alert when the bell character is received (output_vibra)

bool alert_bell_vibra = 12;

clearAlertMessage

open fun clearAlertMessage(): ModuleConfigProtos.ModuleConfig.ExternalNotificationConfig.Builder


True: Alert when a text message arrives (output)

bool alert_message = 5;

clearAlertMessageBuzzer

open fun clearAlertMessageBuzzer(): ModuleConfigProtos.ModuleConfig.ExternalNotificationConfig.Builder


True: Alert when a text message arrives (output_buzzer)

bool alert_message_buzzer = 11;

clearAlertMessageVibra

open fun clearAlertMessageVibra(): ModuleConfigProtos.ModuleConfig.ExternalNotificationConfig.Builder


True: Alert when a text message arrives (output_vibra)

bool alert_message_vibra = 10;

clearEnabled

open fun clearEnabled(): ModuleConfigProtos.ModuleConfig.ExternalNotificationConfig.Builder


Enable the ExternalNotificationModule

bool enabled = 1;

clearNagTimeout

open fun clearNagTimeout(): ModuleConfigProtos.ModuleConfig.ExternalNotificationConfig.Builder


The notification will toggle with 'output_ms' for this time of seconds.
Default is 0 which means don't repeat at all. 60 would mean blink
and/or beep for 60 seconds

uint32 nag_timeout = 14;

clearOutput

open fun clearOutput(): ModuleConfigProtos.ModuleConfig.ExternalNotificationConfig.Builder


Define the output pin GPIO setting Defaults to
EXT_NOTIFY_OUT if set for the board.
In standalone devices this pin should drive the LED to match the UI.

uint32 output = 3;

clearOutputBuzzer

open fun clearOutputBuzzer(): ModuleConfigProtos.ModuleConfig.ExternalNotificationConfig.Builder


Optional: Define a tertiary output pin for an active buzzer
This is used in standalone devices to to match the UI.

uint32 output_buzzer = 9;

clearOutputMs

open fun clearOutputMs(): ModuleConfigProtos.ModuleConfig.ExternalNotificationConfig.Builder


When using in On/Off mode, keep the output on for this many
milliseconds. Default 1000ms (1 second).

uint32 output_ms = 2;

clearOutputVibra

open fun clearOutputVibra(): ModuleConfigProtos.ModuleConfig.ExternalNotificationConfig.Builder


Optional: Define a secondary output pin for a vibra motor
This is used in standalone devices to match the UI.

uint32 output_vibra = 8;

clearUseI2SAsBuzzer

open fun clearUseI2SAsBuzzer(): ModuleConfigProtos.ModuleConfig.ExternalNotificationConfig.Builder


When true, enables devices with native I2S audio output to use the RTTTL over speaker like a buzzer
T-Watch S3 and T-Deck for example have this capability

bool use_i2s_as_buzzer = 15;

clearUsePwm

open fun clearUsePwm(): ModuleConfigProtos.ModuleConfig.ExternalNotificationConfig.Builder


use a PWM output instead of a simple on/off output. This will ignore
the 'output', 'output_ms' and 'active' settings and use the
device.buzzer_gpio instead.

bool use_pwm = 7;

getActive

open fun getActive(): Boolean


IF this is true, the 'output' Pin will be pulled active high, false
means active low.

bool active = 4;

getAlertBell

open fun getAlertBell(): Boolean


True: Alert when the bell character is received (output)

bool alert_bell = 6;

getAlertBellBuzzer

open fun getAlertBellBuzzer(): Boolean


True: Alert when the bell character is received (output_buzzer)

bool alert_bell_buzzer = 13;

getAlertBellVibra

open fun getAlertBellVibra(): Boolean


True: Alert when the bell character is received (output_vibra)

bool alert_bell_vibra = 12;

getAlertMessage

open fun getAlertMessage(): Boolean


True: Alert when a text message arrives (output)

bool alert_message = 5;

getAlertMessageBuzzer

open fun getAlertMessageBuzzer(): Boolean


True: Alert when a text message arrives (output_buzzer)

bool alert_message_buzzer = 11;

getAlertMessageVibra

open fun getAlertMessageVibra(): Boolean


True: Alert when a text message arrives (output_vibra)

bool alert_message_vibra = 10;

getDefaultInstanceForType

open fun getDefaultInstanceForType(): ModuleConfigProtos.ModuleConfig.ExternalNotificationConfig

getDescriptor

fun getDescriptor(): Descriptors.Descriptor

getDescriptorForType

open fun getDescriptorForType(): Descriptors.Descriptor

getEnabled

open fun getEnabled(): Boolean


Enable the ExternalNotificationModule

bool enabled = 1;

getNagTimeout

open fun getNagTimeout(): Int


The notification will toggle with 'output_ms' for this time of seconds.
Default is 0 which means don't repeat at all. 60 would mean blink
and/or beep for 60 seconds

uint32 nag_timeout = 14;

getOutput

open fun getOutput(): Int


Define the output pin GPIO setting Defaults to
EXT_NOTIFY_OUT if set for the board.
In standalone devices this pin should drive the LED to match the UI.

uint32 output = 3;

getOutputBuzzer

open fun getOutputBuzzer(): Int


Optional: Define a tertiary output pin for an active buzzer
This is used in standalone devices to to match the UI.

uint32 output_buzzer = 9;

getOutputMs

open fun getOutputMs(): Int


When using in On/Off mode, keep the output on for this many
milliseconds. Default 1000ms (1 second).

uint32 output_ms = 2;

getOutputVibra

open fun getOutputVibra(): Int


Optional: Define a secondary output pin for a vibra motor
This is used in standalone devices to match the UI.

uint32 output_vibra = 8;

getUseI2SAsBuzzer

open fun getUseI2SAsBuzzer(): Boolean


When true, enables devices with native I2S audio output to use the RTTTL over speaker like a buzzer
T-Watch S3 and T-Deck for example have this capability

bool use_i2s_as_buzzer = 15;

getUsePwm

open fun getUsePwm(): Boolean


use a PWM output instead of a simple on/off output. This will ignore
the 'output', 'output_ms' and 'active' settings and use the
device.buzzer_gpio instead.

bool use_pwm = 7;

isInitialized

fun isInitialized(): Boolean

mergeFrom

open fun mergeFrom(other: ModuleConfigProtos.ModuleConfig.ExternalNotificationConfig): ModuleConfigProtos.ModuleConfig.ExternalNotificationConfig.Builder

open fun mergeFrom(other: Message): ModuleConfigProtos.ModuleConfig.ExternalNotificationConfig.Builder

open fun mergeFrom(input: CodedInputStream, extensionRegistry: ExtensionRegistryLite): ModuleConfigProtos.ModuleConfig.ExternalNotificationConfig.Builder

setActive

open fun setActive(value: Boolean): ModuleConfigProtos.ModuleConfig.ExternalNotificationConfig.Builder


IF this is true, the 'output' Pin will be pulled active high, false
means active low.

bool active = 4;

setAlertBell

open fun setAlertBell(value: Boolean): ModuleConfigProtos.ModuleConfig.ExternalNotificationConfig.Builder


True: Alert when the bell character is received (output)

bool alert_bell = 6;

setAlertBellBuzzer

open fun setAlertBellBuzzer(value: Boolean): ModuleConfigProtos.ModuleConfig.ExternalNotificationConfig.Builder


True: Alert when the bell character is received (output_buzzer)

bool alert_bell_buzzer = 13;

setAlertBellVibra

open fun setAlertBellVibra(value: Boolean): ModuleConfigProtos.ModuleConfig.ExternalNotificationConfig.Builder


True: Alert when the bell character is received (output_vibra)

bool alert_bell_vibra = 12;

setAlertMessage

open fun setAlertMessage(value: Boolean): ModuleConfigProtos.ModuleConfig.ExternalNotificationConfig.Builder


True: Alert when a text message arrives (output)

bool alert_message = 5;

setAlertMessageBuzzer

open fun setAlertMessageBuzzer(value: Boolean): ModuleConfigProtos.ModuleConfig.ExternalNotificationConfig.Builder


True: Alert when a text message arrives (output_buzzer)

bool alert_message_buzzer = 11;

setAlertMessageVibra

open fun setAlertMessageVibra(value: Boolean): ModuleConfigProtos.ModuleConfig.ExternalNotificationConfig.Builder


True: Alert when a text message arrives (output_vibra)

bool alert_message_vibra = 10;

setEnabled

open fun setEnabled(value: Boolean): ModuleConfigProtos.ModuleConfig.ExternalNotificationConfig.Builder


Enable the ExternalNotificationModule

bool enabled = 1;

setNagTimeout

open fun setNagTimeout(value: Int): ModuleConfigProtos.ModuleConfig.ExternalNotificationConfig.Builder


The notification will toggle with 'output_ms' for this time of seconds.
Default is 0 which means don't repeat at all. 60 would mean blink
and/or beep for 60 seconds

uint32 nag_timeout = 14;

setOutput

open fun setOutput(value: Int): ModuleConfigProtos.ModuleConfig.ExternalNotificationConfig.Builder


Define the output pin GPIO setting Defaults to
EXT_NOTIFY_OUT if set for the board.
In standalone devices this pin should drive the LED to match the UI.

uint32 output = 3;

setOutputBuzzer

open fun setOutputBuzzer(value: Int): ModuleConfigProtos.ModuleConfig.ExternalNotificationConfig.Builder


Optional: Define a tertiary output pin for an active buzzer
This is used in standalone devices to to match the UI.

uint32 output_buzzer = 9;

setOutputMs

open fun setOutputMs(value: Int): ModuleConfigProtos.ModuleConfig.ExternalNotificationConfig.Builder


When using in On/Off mode, keep the output on for this many
milliseconds. Default 1000ms (1 second).

uint32 output_ms = 2;

setOutputVibra

open fun setOutputVibra(value: Int): ModuleConfigProtos.ModuleConfig.ExternalNotificationConfig.Builder


Optional: Define a secondary output pin for a vibra motor
This is used in standalone devices to match the UI.

uint32 output_vibra = 8;

setUseI2SAsBuzzer

open fun setUseI2SAsBuzzer(value: Boolean): ModuleConfigProtos.ModuleConfig.ExternalNotificationConfig.Builder


When true, enables devices with native I2S audio output to use the RTTTL over speaker like a buzzer
T-Watch S3 and T-Deck for example have this capability

bool use_i2s_as_buzzer = 15;

setUsePwm

open fun setUsePwm(value: Boolean): ModuleConfigProtos.ModuleConfig.ExternalNotificationConfig.Builder


use a PWM output instead of a simple on/off output. This will ignore
the 'output', 'output_ms' and 'active' settings and use the
device.buzzer_gpio instead.

bool use_pwm = 7;